<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.8">
<meta name="author" content="Beman Dawes, Christopher Kohlhoff, Peter Dimov">
<title>Boost.System: Extensible Error Reporting</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<style>
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
/* Uncomment @import statement below to use as custom stylesheet */
/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
audio,canvas,video{display:inline-block}
audio:not([controls]){display:none;height:0}
script{display:none!important}
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
a{background:transparent}
a:focus{outline:thin dotted}
a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0}
abbr[title]{border-bottom:1px dotted}
b,strong{font-weight:bold}
dfn{font-style:italic}
hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap}
q{quotes:"\201C" "\201D" "\2018" "\2019"}
small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em}
sub{bottom:-.25em}
img{border:0}
svg:not(:root){overflow:hidden}
figure{margin:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal}
button,select{text-transform:none}
button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
html,body{font-size:100%}
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
a:hover{cursor:pointer}
img,object,embed{max-width:100%;height:auto}
object,embed{height:100%}
img{-ms-interpolation-mode:bicubic}
.left{float:left!important}
.right{float:right!important}
.text-left{text-align:left!important}
.text-right{text-align:right!important}
.text-center{text-align:center!important}
.text-justify{text-align:justify!important}
.hide{display:none}
img,object,svg{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px}
select{width:100%}
.center{margin-left:auto;margin-right:auto}
.stretch{width:100%}
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f}
a img{border:none}
p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
p aside{font-size:.875em;line-height:1.35;font-style:italic}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit}
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
ul.square{list-style-type:square}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
abbr{text-transform:none}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
blockquote cite::before{content:"\2014 \0020"}
blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em}
h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}}
table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
table thead,table tfoot{background:#f7f8f7}
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
.clearfix::after,.float-group::after{clear:both}
*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
*:not(pre)>code.nobreak{word-wrap:normal}
*:not(pre)>code.nowrap{white-space:nowrap}
pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
em em{font-style:normal}
strong strong{font-weight:400}
.keyseq{color:rgba(51,51,51,.8)}
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
.keyseq kbd:first-child{margin-left:0}
.keyseq kbd:last-child{margin-right:0}
.menuseq,.menuref{color:#000}
.menuseq b:not(.caret),.menuref{font-weight:inherit}
.menuseq{word-spacing:-.02em}
.menuseq b.caret{font-size:1.25em;line-height:.8}
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
b.button::before{content:"[";padding:0 3px 0 2px}
b.button::after{content:"]";padding:0 2px 0 3px}
p a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
#content{margin-top:1.25em}
#content::before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
#header .details span:first-child{margin-left:-.125em}
#header .details span.email a{color:rgba(0,0,0,.85)}
#header .details br{display:none}
#header .details br+span::before{content:"\00a0\2013\00a0"}
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
#header #revnumber{text-transform:capitalize}
#header #revnumber::after{content:"\00a0"}
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
#toc>ul{margin-left:.125em}
#toc ul.sectlevel0>li>a{font-style:italic}
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
#toc li{line-height:1.3334;margin-top:.3334em}
#toc a{text-decoration:none}
#toc a:active{text-decoration:underline}
#toctitle{color:#7a2518;font-size:1.2em}
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
body.toc2{padding-left:15em;padding-right:0}
#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
body.toc2.toc-right{padding-left:0;padding-right:15em}
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
#toc.toc2{width:20em}
#toc.toc2 #toctitle{font-size:1.375em}
#toc.toc2>ul{font-size:.95em}
#toc.toc2 ul ul{padding-left:1.25em}
body.toc2.toc-right{padding-left:0;padding-right:20em}}
#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
#content #toc>:first-child{margin-top:0}
#content #toc>:last-child{margin-bottom:0}
#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
#footer-text{color:rgba(255,255,255,.8);line-height:1.44}
#content{margin-bottom:.625em}
.sect1{padding-bottom:.625em}
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
.sect1{padding-bottom:1.25em}}
.sect1:last-child{padding-bottom:0}
.sect1+.sect1{border-top:1px solid #e7e7e9}
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
.paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit}
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
.admonitionblock>table td.icon{text-align:center;width:80px}
.admonitionblock>table td.icon img{max-width:none}
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6)}
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
.exampleblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child{margin-bottom:0}
.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
.sidebarblock>:first-child{margin-top:0}
.sidebarblock>:last-child{margin-bottom:0}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;overflow-x:auto;padding:1em;font-size:.8125em}
@media screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
@media screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
.literalblock pre.nowrap,.literalblock pre.nowrap pre,.listingblock pre.nowrap,.listingblock pre.nowrap pre{white-space:pre;word-wrap:normal}
.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
.listingblock pre.highlightjs{padding:0}
.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
.listingblock pre.prettyprint{border-width:0}
.listingblock>.content{position:relative}
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
.listingblock:hover code[data-lang]::before{display:block}
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:#999}
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
table.pyhltable td.code{padding-left:.75em;padding-right:0}
pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #dddddf}
pre.pygments .lineno{display:inline-block;margin-right:.25em}
table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
.quoteblock blockquote{margin:0;padding:0;border:0}
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
.verseblock{margin:0 1em 1.25em}
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
.verseblock pre strong{font-weight:400}
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
.quoteblock .attribution br,.verseblock .attribution br{display:none}
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
.quoteblock.excerpt,.quoteblock .quoteblock{margin:0 0 1.25em;padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;text-align:left;margin-right:0}
table.tableblock{max-width:100%;border-collapse:separate}
p.tableblock:last-child{margin-bottom:0}
td.tableblock>.content{margin-bottom:-1.25em}
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px}
table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0}
table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
table.frame-all{border-width:1px}
table.frame-sides{border-width:0 1px}
table.frame-topbot,table.frame-ends{border-width:1px 0}
table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd){background:#f8f8f7}
table.stripes-none tr,table.stripes-odd tr:nth-of-type(even){background:none}
th.halign-left,td.halign-left{text-align:left}
th.halign-right,td.halign-right{text-align:right}
th.halign-center,td.halign-center{text-align:center}
th.valign-top,td.valign-top{vertical-align:top}
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
th.valign-middle,td.valign-middle{vertical-align:middle}
table thead th,table tfoot th{font-weight:bold}
tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
p.tableblock>code:only-child{background:none;padding:0}
p.tableblock{font-size:1em}
td>div.verse{white-space:pre}
ol{margin-left:1.75em}
ul li ol{margin-left:1.5em}
dl dd{margin-left:1.125em}
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
ul.unstyled,ol.unstyled{margin-left:0}
ul.checklist{margin-left:.625em}
ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
ul.inline>li{margin-left:1.25em}
.unstyled dl dt{font-weight:400;font-style:normal}
ol.arabic{list-style-type:decimal}
ol.decimal{list-style-type:decimal-leading-zero}
ol.loweralpha{list-style-type:lower-alpha}
ol.upperalpha{list-style-type:upper-alpha}
ol.lowerroman{list-style-type:lower-roman}
ol.upperroman{list-style-type:upper-roman}
ol.lowergreek{list-style-type:lower-greek}
.hdlist>table,.colist>table{border:0;background:none}
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
.colist td:not([class]):first-child img{max-width:none}
.colist td:not([class]):last-child{padding:.25em 0}
.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
.imageblock.left{margin:.25em .625em 1.25em 0}
.imageblock.right{margin:.25em 0 1.25em .625em}
.imageblock>.title{margin-bottom:0}
.imageblock.thumb,.imageblock.th{border-width:6px}
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
.image.left{margin-right:.625em}
.image.right{margin-left:.625em}
a.image{text-decoration:none;display:inline-block}
a.image object{pointer-events:none}
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
sup.footnote a,sup.footnoteref a{text-decoration:none}
sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
#footnotes .footnote:last-of-type{margin-bottom:0}
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
.gist .file-data>table td.line-data{width:99%}
div.unbreakable{page-break-inside:avoid}
.big{font-size:larger}
.small{font-size:smaller}
.underline{text-decoration:underline}
.overline{text-decoration:overline}
.line-through{text-decoration:line-through}
.aqua{color:#00bfbf}
.aqua-background{background-color:#00fafa}
.black{color:#000}
.black-background{background-color:#000}
.blue{color:#0000bf}
.blue-background{background-color:#0000fa}
.fuchsia{color:#bf00bf}
.fuchsia-background{background-color:#fa00fa}
.gray{color:#606060}
.gray-background{background-color:#7d7d7d}
.green{color:#006000}
.green-background{background-color:#007d00}
.lime{color:#00bf00}
.lime-background{background-color:#00fa00}
.maroon{color:#600000}
.maroon-background{background-color:#7d0000}
.navy{color:#000060}
.navy-background{background-color:#00007d}
.olive{color:#606000}
.olive-background{background-color:#7d7d00}
.purple{color:#600060}
.purple-background{background-color:#7d007d}
.red{color:#bf0000}
.red-background{background-color:#fa0000}
.silver{color:#909090}
.silver-background{background-color:#bcbcbc}
.teal{color:#006060}
.teal-background{background-color:#007d7d}
.white{color:#bfbfbf}
.white-background{background-color:#fafafa}
.yellow{color:#bfbf00}
.yellow-background{background-color:#fafa00}
span.icon>.fa{cursor:default}
a span.icon>.fa{cursor:inherit}
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
.conum[data-value] *{color:#fff!important}
.conum[data-value]+b{display:none}
.conum[data-value]::after{content:attr(data-value)}
pre .conum[data-value]{position:relative;top:-.125em}
b.conum *{color:inherit!important}
.conum:not([data-value]):empty{display:none}
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
.print-only{display:none!important}
@page{margin:1.25cm .75cm}
@media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
html{font-size:80%}
a{color:inherit!important;text-decoration:underline!important}
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
abbr[title]::after{content:" (" attr(title) ")"}
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
thead{display:table-header-group}
svg{max-width:100%}
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
body.book #header{text-align:center}
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
body.book #header .details{border:0!important;display:block;padding:0!important}
body.book #header .details span:first-child{margin-left:0!important}
body.book #header .details br{display:block}
body.book #header .details br+span::before{content:none!important}
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
.listingblock code[data-lang]::before{display:block}
#footer{padding:0 .9375em}
.hide-on-print{display:none!important}
.print-only{display:block!important}
.hide-for-print{display:none!important}
.show-for-print{display:inherit!important}}
@media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem}
.sect1{padding:0!important}
.sect1+.sect1{border:0}
#footer{background:none}
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
</style>
</head>
<body class="article toc2 toc-left">
<div id="header">
<h1>Boost.System: Extensible Error Reporting</h1>
<div class="details">
<span id="author" class="author">Beman Dawes, Christopher Kohlhoff, Peter Dimov</span><br>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#introduction">Introduction</a></li>
<li><a href="#changes">Revision History</a>
<ul class="sectlevel2">
<li><a href="#changes_in_boost_1_77">Changes in Boost 1.77</a></li>
<li><a href="#changes_in_boost_1_76">Changes in Boost 1.76</a></li>
<li><a href="#changes_in_boost_1_75">Changes in Boost 1.75</a></li>
<li><a href="#changes_in_boost_1_74">Changes in Boost 1.74</a></li>
<li><a href="#changes_in_boost_1_69">Changes in Boost 1.69</a></li>
<li><a href="#changes_in_boost_1_68">Changes in Boost 1.68</a></li>
<li><a href="#changes_in_boost_1_65">Changes in Boost 1.65</a></li>
</ul>
</li>
<li><a href="#rationale">Design Rationale</a></li>
<li><a href="#reference">Reference</a>
<ul class="sectlevel2">
<li><a href="#ref_use_of_c11_and_c14_features">Use of C&#43;&#43;11 and C&#43;&#43;14 Features</a></li>
<li><a href="#ref_macros">Macros</a></li>
<li><a href="#ref_deprecated_names">Deprecated Names</a></li>
<li><a href="#ref_boostsystemis_error_code_enum_hpp">&lt;boost/system/&#8203;is_error_code_enum.hpp&gt;</a>
<ul class="sectlevel3">
<li><a href="#ref_is_error_code_enum">is_error_code_enum</a></li>
</ul>
</li>
<li><a href="#ref_boostsystemis_error_condition_enum_hpp">&lt;boost/system/&#8203;is_error_condition_enum.hpp&gt;</a>
<ul class="sectlevel3">
<li><a href="#ref_is_error_condition_enum">is_error_condition_enum</a></li>
</ul>
</li>
<li><a href="#ref_boostsystemerrc_hpp">&lt;boost/system/&#8203;errc.hpp&gt;</a>
<ul class="sectlevel3">
<li><a href="#ref_errc">errc</a></li>
</ul>
</li>
<li><a href="#ref_boostsystemerror_category_hpp">&lt;boost/system/&#8203;error_category.hpp&gt;</a>
<ul class="sectlevel3">
<li><a href="#ref_error_category">error_category</a>
<ul class="sectlevel4">
<li><a href="#ref_constructors">Constructors</a></li>
<li><a href="#ref_virtuals">Virtuals</a></li>
<li><a href="#ref_comparisons">Comparisons</a></li>
<li><a href="#ref_conversions">Conversions</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#ref_boostsystemsystem_category_hpp">&lt;boost/system/&#8203;system_category.hpp&gt;</a>
<ul class="sectlevel3">
<li><a href="#ref_system_category">system_category</a></li>
</ul>
</li>
<li><a href="#ref_boostsystemgeneric_category_hpp">&lt;boost/system/&#8203;generic_category.hpp&gt;</a>
<ul class="sectlevel3">
<li><a href="#ref_generic_category">generic_category</a></li>
</ul>
</li>
<li><a href="#ref_boostsystemerror_code_hpp">&lt;boost/system/&#8203;error_code.hpp&gt;</a>
<ul class="sectlevel3">
<li><a href="#ref_error_code">error_code</a>
<ul class="sectlevel4">
<li><a href="#ref_constructors_2">Constructors</a></li>
<li><a href="#ref_modifiers">Modifiers</a></li>
<li><a href="#ref_observers">Observers</a></li>
<li><a href="#ref_comparisons_2">Comparisons</a></li>
<li><a href="#ref_conversions_2">Conversions</a></li>
<li><a href="#ref_stream_insertion">Stream Insertion</a></li>
<li><a href="#ref_nonmembers">Nonmembers</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#ref_boostsystemerror_condition_hpp">&lt;boost/system/&#8203;error_condition.hpp&gt;</a>
<ul class="sectlevel3">
<li><a href="#ref_error_condition">error_condition</a>
<ul class="sectlevel4">
<li><a href="#ref_constructors_3">Constructors</a></li>
<li><a href="#ref_modifiers_2">Modifiers</a></li>
<li><a href="#ref_observers_2">Observers</a></li>
<li><a href="#ref_comparisons_3">Comparisons</a></li>
<li><a href="#ref_conversions_3">Conversions</a></li>
<li><a href="#ref_stream_insertion_2">Stream Insertion</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#ref_boostsystemsystem_error_hpp">&lt;boost/system/&#8203;system_error.hpp&gt;</a>
<ul class="sectlevel3">
<li><a href="#ref_class_system_error">Class system_error</a>
<ul class="sectlevel4">
<li><a href="#ref_constructors_4">Constructors</a></li>
<li><a href="#ref_observers_3">Observers</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#ref_boostsystem_hpp">&lt;boost/system.hpp&gt;</a></li>
</ul>
</li>
<li><a href="#history">History</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
<li><a href="#copyright">Copyright and License</a></li>
</ul>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="introduction">Introduction</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Error conditions originating from the operating system or other low-level
application program interfaces (API&#8217;s) are typically reported via an integer
representing an error code. When these low-level API calls are wrapped in
portable code, such as in a portable library, some users want to deal with the
error codes in portable ways. Other users need to get at the system specific
error codes, so they can deal with system specific needs. The Boost System
library provides simple, light-weight <code>error_code</code> objects that encapsulate
system-specific error code values, yet also provide access to more abstract
and portable error conditions via <code>error_condition</code> objects.</p>
</div>
<div class="paragraph">
<p>Because <code>error_code</code> objects can represent errors from sources other than the
operating system, including user-defined sources, each <code>error_code</code> and
<code>error_condition</code> has an associated <code>error_category</code>.</p>
</div>
<div class="paragraph">
<p>An exception class, <code>system_error</code>, is provided. Derived from
<code>std::runtime_error</code>, it captures the underlying <code>error_code</code> for the problem
causing the exception so that this important information is not lost.</p>
</div>
<div class="paragraph">
<p>While exceptions are the preferred C&#43;&#43; default error code reporting
mechanism, users of libraries dependent on low-level API&#8217;s often need overloads
reporting error conditions via error code arguments and/or return values rather
than via throwing exceptions. Otherwise, when errors are not exceptional
occurrences and must be dealt with as they arise, programs become littered with
try/catch blocks, unreadable, and inefficient. The Boost System library
supports both error reporting by exception and by error code.</p>
</div>
<div class="paragraph">
<p>In addition to portable errors codes and conditions supported by the
<code>error_code.hpp</code> header, system-specific headers support the Cygwin, Linux,
and Windows platforms. These headers are effectively no-ops if included for
platforms other than their intended target.</p>
</div>
<div class="paragraph">
<p>Boost.System is part of the C&#43;&#43;11 Standard Library.
A number of changes, particularly to names, were made by the C++ committee
during standardization. The Boost implementation has been tracking those changes.
See <a href="#ref_deprecated_names">Deprecated Names</a> for synonyms provided to prevent
breakage of existing user code.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="changes">Revision History</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="changes_in_boost_1_77">Changes in Boost 1.77</h3>
<div class="ulist">
<ul>
<li>
<p>The conversion operator from <code>error_category</code> to <code>std::error_category</code>
has been improved and no longer requires <code>&lt;map&gt;</code> or <code>&lt;mutex&gt;</code>.</p>
</li>
<li>
<p>The comparison operators of <code>error_category</code> are now inline friends
instead of member functions (a side effect of the previous change.)</p>
</li>
<li>
<p><code>error_condition</code> now defers calling <code>generic_category()</code> to avoid
instantiating the object until it&#8217;s actually needed.</p>
</li>
<li>
<p><code>error_condition::failed</code> and <code>error_condition::message</code> have been
undeprecated, and <code>operator bool()</code> now once again returns <code>failed()</code>.</p>
</li>
<li>
<p>The system category now doesn&#8217;t call <code>generic_category()</code>, to avoid
instantiating the object.</p>
</li>
<li>
<p>The return value of <code>default_error_condition</code> changes in some cases into
an <code>error_condition</code> from the generic category, instead of from the system
category. This happens on POSIX when the input <code>error_code</code> is from
the system category and does not correspond to any <code>errc_t</code> value.</p>
</li>
<li>
<p>The interoperability of <code>error_code</code> and <code>std::error_code</code> has been
improved substantially. It is now possible to construct
<code>boost::system::error_code</code> from <code>std::error_code</code>, and it&#8217;s possible
to pass <code>boost::system::error_code</code> to functions taking <code>std::error_code&amp;</code>.</p>
</li>
<li>
<p>A stream insertion operator for <code>error_condition</code> has been added.</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="changes_in_boost_1_76">Changes in Boost 1.76</h3>
<div class="ulist">
<ul>
<li>
<p><code>windows_error.hpp</code> is no longer deprecated.</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="changes_in_boost_1_75">Changes in Boost 1.75</h3>
<div class="ulist">
<ul>
<li>
<p>The platform-specific headers <code>windows_error.hpp</code>, <code>linux_error.hpp</code>,
and <code>cygwin_error.hpp</code> emit deprecation messages and are slated for
removal.</p>
</li>
<li>
<p>The old names for <code>generic_category()</code> and <code>system_category()</code> emit
deprecation messages and are slated for removal.</p>
</li>
<li>
<p><code>error_condition::failed</code> is deprecated and is slated for removal.
<code>operator bool()</code> for <code>error_condition</code> has been reverted to its old
meaning of <code>value() != 0</code>. This is done for compatibility with
<code>std::error_condition</code> as the next release is expected to improve
interoperability with <code>&lt;system_error&gt;</code> even further. <em>Note that this
does not affect</em> <code>error_code::failed</code>, which is still alive and well.</p>
</li>
<li>
<p>The overload of <code>error_condition::message</code> that takes a buffer is
deprecated and is slated for removal, for the same reasons. <em>Note that
this does not affect</em> <code>error_code::message</code>.</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="changes_in_boost_1_74">Changes in Boost 1.74</h3>
<div class="ulist">
<ul>
<li>
<p><code>operator bool()</code> now returns <code>failed()</code> instead of <code>value() != 0</code>.</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="changes_in_boost_1_69">Changes in Boost 1.69</h3>
<div class="ulist">
<ul>
<li>
<p>Boost.System is now header-only. A stub library is still built for
compatibility, but linking to it is no longer necessary.</p>
</li>
<li>
<p>Even more functions have been marked <code>constexpr</code>.</p>
</li>
<li>
<p>The destructor of <code>error_category</code> is now protected and no longer
virtual. This is a <em>potentially breaking change</em> but its impact
is expected to be limited.</p>
</li>
<li>
<p><code>error_category</code> now has a constructor that accepts a 64 bit identifier,
enabling distinct category objects to compare equal.</p>
</li>
<li>
<p>The constructors of <code>error_category</code> are now protected.</p>
</li>
<li>
<p>A non-allocating, nonthrowing overload of <code>message</code> has been added.</p>
</li>
<li>
<p>A virtual function <code>failed</code> has been added, allowing categories for
which success is not synonymous with 0.</p>
</li>
<li>
<p>The deprecated <code>boost::system::throws</code> object has been removed.</p>
</li>
<li>
<p><code>boost::throws()</code> is now deprecated and its use is discouraged.</p>
</li>
<li>
<p>The constructor of <code>system_error</code> taking a single <code>error_code</code> argument
is now explicit.</p>
</li>
<li>
<p><code>system_error::code()</code> now returns by value.</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="changes_in_boost_1_68">Changes in Boost 1.68</h3>
<div class="paragraph">
<p>On a C&#43;&#43;14 compiler, many Boost.System functions and member functions
are now <code>constexpr</code>, and <code>error_code</code> and <code>error_condition</code> are literal
classes.</p>
</div>
<div class="paragraph">
<p>In addition to enabling use in constant expressions (and <code>constexpr</code>
functions), this significantly improves the quality of the generated code.</p>
</div>
<div class="paragraph">
<p>As a result of this change, however, now using Boost.System from C&#43;&#43;14
or C&#43;&#43;17 code requires that the library be also built with C&#43;&#43;14 or
above. This is the default on GCC 6 and newer, but not on GCC 5 or Clang.
One can build Boost for C&#43;&#43;14 by passing the <code>cxxstd=14</code> option to <code>b2</code>.</p>
</div>
<div class="paragraph">
<p>(Previous versions allowed code built against any C&#43;&#43; standard to link
with Boost.System built against any C&#43;&#43; standard. In 1.68, code using
any C&#43;&#43; standard can link with Boost.System built with C&#43;&#43;14 or above,
but if Boost.System is built with C&#43;&#43;11 or below, only code also built
with C&#43;&#43;11 and below can link to it successfully.)</p>
</div>
</div>
<div class="sect2">
<h3 id="changes_in_boost_1_65">Changes in Boost 1.65</h3>
<div class="paragraph">
<p>On a C&#43;&#43;11 compiler, Boost.System now provides implicit conversions
from <code>boost::system::error_category</code>, <code>error_code</code>, and <code>error_condition</code>
to their standard equivalents from <code>&lt;system_error&gt;</code>.</p>
</div>
<div class="paragraph">
<p>This allows libraries to expose a C&#43;&#43;11 interface and report errors
via <code>std::error_code</code> even when using Boost.System, directly or through a
dependency such as Boost.ASIO.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="rationale">Design Rationale</h2>
<div class="sectionbody">
<div class="paragraph">
<p><code>error_code</code> and <code>error_condition</code> are designed as value types so
they can be copied without slicing and do not require heap allocation, but
still have polymorphic behavior based on the error category. This is achieved
by abstract base class <code>error_category</code> supplying the polymorphic behavior,
and <code>error_code</code> and <code>error_condition</code> containing a pointer to an object of a
type derived from <code>error_category</code>.</p>
</div>
<div class="paragraph">
<p>Many of the detailed design decisions were driven by the requirements that
users to be able to add additional error categories, and that it be no more
difficult to write portable code than system-specific code.</p>
</div>
<div class="paragraph">
<p>The <code>operator&lt;&lt;</code> overload for <code>error_code</code> eliminates a misleading conversion to
<code>bool</code> in code like <code>cout &lt;&lt; ec</code>, where <code>ec</code> is of type <code>error_code</code>. It is also
useful in its own right.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="reference">Reference</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="ref_use_of_c11_and_c14_features">Use of C&#43;&#43;11 and C&#43;&#43;14 Features</h3>
<div class="paragraph">
<p>The library is documented to use several C&#43;&#43;11 and C&#43;&#43;14 features,
including <code>noexcept</code>, explicit conversion operators and <code>constexpr</code>. The
actual implementation uses C&#43;&#43;11 and C&#43;&#43;14 features only when they are
available, and otherwise falls back on C&#43;&#43;03 features.</p>
</div>
</div>
<div class="sect2">
<h3 id="ref_macros">Macros</h3>
<div class="paragraph">
<p>When <code>BOOST_SYSTEM_ENABLE_DEPRECATED</code> is defined, the library provides
deprecated features for compatibility. These features are bound to eventually
disappear.</p>
</div>
<div class="paragraph">
<p>When <code>BOOST_SYSTEM_USE_UTF8</code> is defined, on Windows the library returns
UTF-8 messages using code page <code>CP_UTF8</code> instead of the default <code>CP_ACP</code>.
This macro has no effect on POSIX.</p>
</div>
</div>
<div class="sect2">
<h3 id="ref_deprecated_names">Deprecated Names</h3>
<div class="paragraph">
<p>In the process of adding Boost.System to the C&#43;&#43;11 standard library, the
C&#43;&#43; committee changed some names. To ease transition, Boost.System deprecates
the old names, but will provide them when the macro <code>BOOST_SYSTEM_ENABLE_DEPRECATED</code> is defined.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Old usage, now deprecated</th>
<th class="tableblock halign-left valign-top">Replacement</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>get_generic_category()</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>generic_category()</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>get_system_category()</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>system_category()</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>namespace posix</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>namespace errc</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>namespace posix_error</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>namespace errc</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>get_posix_category()</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>generic_category()</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>posix_category</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>generic_category()</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>errno_ecat</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>generic_category()</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>native_ecat</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>system_category()</code></p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="ref_boostsystemis_error_code_enum_hpp">&lt;boost/system/&#8203;is_error_code_enum.hpp&gt;</h3>
<div class="sect3">
<h4 id="ref_is_error_code_enum">is_error_code_enum</h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>namespace boost {
  namespace system {

    template&lt;class T&gt;
      struct is_error_code_enum { static const bool value = false; };

  } // namespace system
} // namespace boost</code></pre>
</div>
</div>
<div class="paragraph">
<p>Users may specialize <code>is_error_code_enum</code> for their error enumeration
types to indicate that they should be eligible for automatic conversions
to <code>error_code</code>. This conversion calls <code>make_error_code(e)</code>, which should
be provided in the same namespace as the enumeration type.</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="ref_boostsystemis_error_condition_enum_hpp">&lt;boost/system/&#8203;is_error_condition_enum.hpp&gt;</h3>
<div class="sect3">
<h4 id="ref_is_error_condition_enum">is_error_condition_enum</h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>namespace boost {
  namespace system {

    template&lt;class T&gt;
      struct is_error_condition_enum { static const bool value = false; };

  } // namespace system
} // namespace boost</code></pre>
</div>
</div>
<div class="paragraph">
<p>Users may specialize <code>is_error_condition_enum</code> for their error enumeration
types to indicate that they should be eligible for automatic conversions
to <code>error_condition</code>. This conversion calls <code>make_error_condition(e)</code>, which
should be provided in the same namespace as the enumeration type.</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="ref_boostsystemerrc_hpp">&lt;boost/system/&#8203;errc.hpp&gt;</h3>
<div class="sect3">
<h4 id="ref_errc">errc</h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>namespace boost {
  namespace system {

    namespace errc {
      enum errc_t
      {
        success = 0,
        address_family_not_supported,   //EAFNOSUPPORT
        address_in_use,                 //EADDRINUSE
        address_not_available,          //EADDRNOTAVAIL
        already_connected,              //EISCONN
        argument_list_too_long,         //E2BIG
        argument_out_of_domain,         //EDOM
        bad_address,                    //EFAULT
        bad_file_descriptor,            //EBADF
        bad_message,                    //EBADMSG
        broken_pipe,                    //EPIPE
        connection_aborted,             //ECONNABORTED
        connection_already_in_progress, //EALREADY
        connection_refused,             //ECONNREFUSED
        connection_reset,               //ECONNRESET
        cross_device_link,              //EXDEV
        destination_address_required,   //EDESTADDRREQ
        device_or_resource_busy,        //EBUSY
        directory_not_empty,            //ENOTEMPTY
        executable_format_error,        //ENOEXEC
        file_exists,                    //EEXIST
        file_too_large,                 //EFBIG
        filename_too_long,              //ENAMETOOLONG
        function_not_supported,         //ENOSYS
        host_unreachable,               //EHOSTUNREACH
        identifier_removed,             //EIDRM
        illegal_byte_sequence,          //EILSEQ
        inappropriate_io_control_operation, //ENOTTY
        interrupted,                    //EINTR
        invalid_argument,               //EINVAL
        invalid_seek,                   //ESPIPE
        io_error,                       //EIO
        is_a_directory,                 //EISDIR
        message_size,                   //EMSGSIZE
        network_down,                   //ENETDOWN
        network_reset,                  //ENETRESET
        network_unreachable,            //ENETUNREACH
        no_buffer_space,                //ENOBUFS
        no_child_process,               //ECHILD
        no_link,                        //ENOLINK
        no_lock_available,              //ENOLCK
        no_message_available,           //ENODATA
        no_message,                     //ENOMSG
        no_protocol_option,             //ENOPROTOOPT
        no_space_on_device,             //ENOSPC
        no_stream_resources,            //ENOSR
        no_such_device_or_address,      //ENXIO
        no_such_device,                 //ENODEV
        no_such_file_or_directory,      //ENOENT
        no_such_process,                //ESRCH
        not_a_directory,                //ENOTDIR
        not_a_socket,                   //ENOTSOCK
        not_a_stream,                   //ENOSTR
        not_connected,                  //ENOTCONN
        not_enough_memory,              //ENOMEM
        not_supported,                  //ENOTSUP
        operation_canceled,             //ECANCELED
        operation_in_progress,          //EINPROGRESS
        operation_not_permitted,        //EPERM
        operation_not_supported,        //EOPNOTSUPP
        operation_would_block,          //EWOULDBLOCK
        owner_dead,                     //EOWNERDEAD
        permission_denied,              //EACCES
        protocol_error,                 //EPROTO
        protocol_not_supported,         //EPROTONOSUPPORT
        read_only_file_system,          //EROFS
        resource_deadlock_would_occur,  //EDEADLK
        resource_unavailable_try_again, //EAGAIN
        result_out_of_range,            //ERANGE
        state_not_recoverable,          //ENOTRECOVERABLE
        stream_timeout,                 //ETIME
        text_file_busy,                 //ETXTBSY
        timed_out,                      //ETIMEDOUT
        too_many_files_open_in_system,  //ENFILE
        too_many_files_open,            //EMFILE
        too_many_links,                 //EMLINK
        too_many_synbolic_link_levels,  //ELOOP
        value_too_large,                //EOVERFLOW
        wrong_protocol_type             //EPROTOTYPE
      };

    } // namespace errc

    template&lt;&gt; struct is_error_condition_enum&lt;errc::errc_t&gt;
      { static const bool value = true; };

    constexpr error_code make_error_code( errc::errc_t e ) noexcept;
    constexpr error_condition make_error_condition( errc::errc_t e ) noexcept;

  } // namespace system
} // namespace boost</code></pre>
</div>
</div>
<div class="paragraph">
<p>The predefined enumeration type <code>errc::errc_t</code> provides named constants
corresponding to the values of the <code>&lt;cerrno&gt;</code> macros.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr error_condition make_error_condition( errc::errc_t e ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>error_condition( e, generic_category() )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="paragraph">
<p>Since <code>errc::errc_t</code> provides a specialization of <code>is_error_condition_enum</code>
and an overload of <code>make_error_condition</code>, it can be converted implicitly to
an <code>error_condition</code>. This is typically useful when comparing <code>error_code</code>
values returned from APIs to a portable condition, as in the below example:
* </p>
</div>
<div class="paragraph">
<p>+</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>void api_function( boost::system::error_code&amp; ec );

void my_function()
{
    boost::system::error_code ec;
    api_function( ec );

    if( ec == boost::system::errc::no_such_file_or_directory )
    {
        // an entity wasn't found (ENOENT)
        // handle this condition
    }
}</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr error_code make_error_code( errc::errc_t e ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>error_code( e, generic_category() )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="paragraph">
<p>In addition to <code>make_error_condition</code>, <code>errc::errc_t</code> provides an overload of
<code>make_error_code</code>. This allows the creation of generic error codes, an
operation typically useful when a function needs to signal a generic failure
that does not come from an underlying API, such as for instance an out of
memory condition:
* </p>
</div>
<div class="paragraph">
<p>+</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>void my_api_function( boost::system::error_code&amp; ec )
{
    void* p = std::malloc( 16 );

    if( p == 0 )
    {
        // return ENOMEM
        ec = make_error_code( boost::system::errc::out_of_memory );
        return;
    }

    // use p
}</code></pre>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="ref_boostsystemerror_category_hpp">&lt;boost/system/&#8203;error_category.hpp&gt;</h3>
<div class="sect3">
<h4 id="ref_error_category">error_category</h4>
<div class="paragraph">
<p>The class <code>error_category</code> defines the base class for types used
to identify the source and encoding of a particular category of error code.</p>
</div>
<div class="paragraph">
<p>Classes may be derived from <code>error_category</code> to support categories of
errors in addition to those defined in Boost.System.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>namespace boost {
  namespace system {

    class error_category
    {
    public: // noncopyable

      error_category( error_category const &amp; ) = delete;
      error_category&amp; operator=( error_category const &amp; ) = delete;

    protected:

      ~error_category() = default;

      constexpr error_category() noexcept;
      explicit constexpr error_category( unsigned long long id ) noexcept;

    public:

      virtual const char * name() const noexcept = 0;

      virtual error_condition default_error_condition( int ev ) const noexcept;

      virtual bool equivalent( int code, const error_condition &amp; condition )
        const noexcept;
      virtual bool equivalent( const error_code &amp; code, int condition )
        const noexcept;

      virtual std::string message( int ev ) const = 0;
      virtual char const * message( int ev, char * buffer, std::size_t len )
        const noexcept;

      virtual bool failed( int ev ) const noexcept;

      friend constexpr bool operator==( const error_category &amp; lhs,
        const error_category &amp; rhs ) noexcept;
      friend constexpr bool operator!=( const error_category &amp; lhs,
        const error_category &amp; rhs ) noexcept;

      friend constexpr bool operator&lt; ( const error_category &amp; lhs,
        const error_category &amp; rhs ) noexcept;

      operator std::error_category const &amp; () const;

    private:

      unsigned long long id_; // exposition only

    };
  }
}</code></pre>
</div>
</div>
<div class="sect4">
<h5 id="ref_constructors">Constructors</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr error_category() noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Initializes <code>id_</code> to 0.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>Since equivalence for categories that do not have an identifier is
based on comparing object addresses, a user-defined derived category of type
<code>C</code> that uses this constructor should ensure that only one object of type <code>C</code>
exists in the program.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>explicit constexpr error_category( unsigned long long id ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Initializes <code>id_</code> to <code>id</code>.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>User-defined derived categories that use this constructor are considered
equivalent when their identifiers match. Therefore, those categories may have more
than one instance existing in a program, but to minimize the possibility of
collision, their identifiers must be randomly chosen (at the time the category
is implemented, not at runtime). One way of generating a 64 bit random identifier
is <a href="https://www.random.org/cgi-bin/randbyte?nbytes=8&amp;format=h" class="bare">https://www.random.org/cgi-bin/randbyte?nbytes=8&amp;format=h</a>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_virtuals">Virtuals</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>virtual const char * name() const noexcept = 0;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>In derived classes, a character literal naming the error category.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>virtual error_condition default_error_condition( int ev ) const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p>In derived classes, an error condition corresponding to <code>ev</code>.
The returned error condition will typically come from the generic category.</p>
</li>
<li>
<p>In the default implementation, <code>error_condition( ev, *this )</code>.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>virtual bool equivalent( int code, const error_condition &amp; condition )
  const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p>In derived classes, <code>true</code> when <code>error_code( code, *this )</code> is equivalent to <code>condition</code>.</p>
</li>
<li>
<p>In the default implementation, <code>default_error_condition( code ) == condition</code>.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>virtual bool equivalent( const error_code &amp; code, int condition )
  const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p>In derived classes, <code>true</code> when <code>code</code> is equivalent to <code>error_condition( condition, *this )</code>.</p>
</li>
<li>
<p>In the default implementation, <code>*this == code.category() &amp;&amp; code.value() == condition</code>.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>virtual std::string message( int ev ) const = 0;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>In derived classes, a string that describes the error denoted by <code>ev</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>virtual char const * message( int ev, char * buffer, std::size_t len )
  const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p>Derived classes should either</p>
<div class="ulist">
<ul>
<li>
<p>return a pointer to a character literal describing the error denoted by <code>ev</code>, or</p>
</li>
<li>
<p>copy a string describing the error into <code>buffer</code>, truncating it to <code>len-1</code>
characters and storing a null terminator, and return <code>buffer</code>. If <code>len</code> is 0,
nothing is copied, but the function still returns <code>buffer</code>. Note that
when <code>len</code> is 0, <code>buffer</code> may be <code>nullptr</code>.</p>
</li>
</ul>
</div>
</li>
<li>
<p>The default implementation calls <code>message(ev)</code> and copies the result into
<code>buffer</code>, truncating it to <code>len-1</code> characters and storing a null terminator.
If <code>len</code> is 0, copies nothing. Returns <code>buffer</code>. If <code>message(ev)</code> throws an
exception, the string <code>"Message text unavailable"</code> is used.</p>
</li>
</ul>
</div>
</dd>
<dt class="hdlist1">Example: </dt>
<dd>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>const char* my_category::message(int ev, char* buffer, size_t len) const noexcept
{
  switch(ev)
  {
  case 0: return "no error";
  case 1: return "voltage out of range";
  case 2: return "impedance mismatch";
  case 31:
  case 32:
  case 33:
    std::snprintf(buffer, len, "component %d failure", ev-30);
    return buffer;
  default:
    std::snprintf(buffer, len, "unknown error %d", ev);
    return buffer;
  }
}</code></pre>
</div>
</div>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>virtual bool failed( int ev ) const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p>In derived classes, <code>true</code> when <code>ev</code> represents a failure.</p>
</li>
<li>
<p>In the default implementation, <code>ev != 0</code>.</p>
</li>
</ul>
</div>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>All calls to this function with the same <code>ev</code> must return the same value.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_comparisons">Comparisons</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend constexpr bool operator==( const error_category &amp; lhs,
  const error_category &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>rhs.id_ == 0? &amp;lhs == &amp;rhs: lhs.id_ == rhs.id_</code>.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>Two category objects are considered equivalent when they have
matching nonzero identifiers, or are the same object.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend constexpr bool operator!=( const error_category &amp; lhs,
  const error_category &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>!( lhs == rhs )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr bool operator&lt; ( const error_category &amp; lhs,
  const error_category &amp; rhs ) const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<div class="ulist">
<ul>
<li>
<p>If <code>lhs.id_ &lt; rhs.id_</code>, <code>true</code>;</p>
</li>
<li>
<p>Otherwise, if <code>lhs.id_ &gt; rhs.id_</code>, <code>false</code>;</p>
</li>
<li>
<p>Otherwise, if <code>rhs.id_ != 0</code>, <code>false</code>;</p>
</li>
<li>
<p>Otherwise, <code>std::less&lt;error_category const *&gt;()( &amp;lhs, &amp;rhs )</code>.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_conversions">Conversions</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>operator std::error_category const &amp; () const;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>A reference to an <code>std::error_category</code> object corresponding
to <code>*this</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="ref_boostsystemsystem_category_hpp">&lt;boost/system/&#8203;system_category.hpp&gt;</h3>
<div class="sect3">
<h4 id="ref_system_category">system_category</h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>namespace boost {
  namespace system {

    constexpr const error_category &amp; system_category() noexcept;

  } // namespace system
} // namespace boost</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr const error_category &amp; system_category() noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>A reference to a predefined <code>error_category</code> object identifying
errors originating from the operating system.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2">
<h3 id="ref_boostsystemgeneric_category_hpp">&lt;boost/system/&#8203;generic_category.hpp&gt;</h3>
<div class="sect3">
<h4 id="ref_generic_category">generic_category</h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>namespace boost {
  namespace system {

    constexpr const error_category &amp; generic_category() noexcept;

  } // namespace system
} // namespace boost</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr const error_category &amp; generic_category() noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>A reference to a predefined <code>error_category</code> object identifying
portable error codes and conditions.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2">
<h3 id="ref_boostsystemerror_code_hpp">&lt;boost/system/&#8203;error_code.hpp&gt;</h3>
<div class="sect3">
<h4 id="ref_error_code">error_code</h4>
<div class="paragraph">
<p>The class <code>error_code</code> describes an object used to hold error code
values, such as those originating from the operating system or other
low-level application program interfaces. It&#8217;s an adjunct to error reporting
by exception.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>namespace boost {
  namespace system {

    class error_code {
    public:

      // constructors:

      constexpr error_code() noexcept;
      constexpr error_code( int val, const error_category &amp; cat ) noexcept;

      template &lt;class ErrorCodeEnum&gt;
        constexpr error_code( ErrorCodeEnum e ) noexcept;

      error_code( std::error_code const&amp; ec ) noexcept;

      // modifiers:

      constexpr void assign( int val, const error_category &amp; cat ) noexcept;

      template&lt;typename ErrorCodeEnum&gt;
        constexpr error_code &amp; operator=( ErrorCodeEnum e ) noexcept;

      constexpr void clear() noexcept;

      // observers:

      constexpr int value() const noexcept;
      constexpr const error_category &amp; category() const noexcept;

      error_condition default_error_condition() const noexcept;

      std::string message() const;
      char const * message( char * buffer, std::size_t len ) const noexcept;

      constexpr bool failed() const noexcept;
      constexpr explicit operator bool() const noexcept;

      // comparisons:

      friend constexpr bool operator==( const error_code &amp; lhs,
        const error_code &amp; rhs ) noexcept;

      friend constexpr bool operator!=( const error_code &amp; lhs,
        const error_code &amp; rhs ) noexcept;

      friend constexpr bool operator&lt;( const error_code &amp; lhs,
        const error_code &amp; rhs ) noexcept;

      friend bool operator==( const error_code &amp; code,
        const error_condition &amp; condition ) noexcept;
      friend bool operator==( const error_condition &amp; condition,
        const error_code &amp; code ) noexcept;

      friend bool operator!=( const error_code &amp; code,
        const error_condition &amp; condition ) noexcept;
      friend bool operator!=( const error_condition &amp; condition,
        const error_code &amp; code ) noexcept;

      friend bool operator==( const error_code &amp; lhs,
        const std::error_code &amp; rhs ) noexcept;
      friend bool operator==( const std::error_code &amp; lhs,
        const error_code &amp; rhs ) noexcept;

      friend bool operator!=( const error_code &amp; lhs,
        const std::error_code &amp; rhs ) noexcept;
      friend bool operator!=( const std::error_code &amp; lhs,
        const error_code &amp; rhs ) noexcept;

      template&lt;class E&gt;
      friend constexpr bool operator==( const error_code &amp; lhs, E rhs ) noexcept;
      template&lt;class E&gt;
      friend constexpr bool operator==( E lhs, const error_code &amp; rhs ) noexcept;

      template&lt;class E&gt;
      friend constexpr bool operator!=( const error_code &amp; lhs, E rhs ) noexcept;
      template&lt;class E&gt;
      friend constexpr bool operator!=( E lhs, const error_code &amp; rhs ) noexcept;

      // conversions:

      operator std::error_code() const;
      operator std::error_code();
      template&lt;class T&gt; operator T&amp; (); // only when T=std::error_code

      // stream insertion:

      template &lt;class charT, class traits&gt;
        std::basic_ostream&lt;charT, traits&gt;&amp;
          operator&lt;&lt;( basic_ostream&lt;charT, traits&gt;&amp; os, const error_code &amp; ec );
    };

    // non-member functions

    std::size_t hash_value( const error_code &amp; ec );

  }
}</code></pre>
</div>
</div>
<div class="sect4">
<h5 id="ref_constructors_2">Constructors</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr error_code() noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>value() == 0</code>; <code>category() == system_category()</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr error_code( int val, const error_category &amp; cat ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>value() == val</code>; <code>category() == cat</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>template &lt;class ErrorCodeEnum&gt;
  constexpr error_code( ErrorCodeEnum e ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>*this == make_error_code( e )</code>.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>This constructor is only enabled when <code>is_error_code_enum&lt;ErrorCodeEnum&gt;::value</code> is <code>true</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>error_code( std::error_code const &amp; ec ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>Construct an <code>error_code</code> that wraps <code>ec</code>.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p><code>value()</code> and <code>category()</code> are unspecified.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_modifiers">Modifiers</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr void assign( int val, const error_category &amp; cat ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>value() == val</code>; <code>category() == cat</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>template&lt;typename ErrorCodeEnum&gt;
  constexpr error_code &amp; operator=( ErrorCodeEnum e ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>*this == make_error_code( e )</code>.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>This operator is only enabled when <code>is_error_code_enum&lt;ErrorCodeEnum&gt;::value</code> is <code>true</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr void clear() noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>value() == 0</code>; <code>category() == system_category()</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_observers">Observers</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr int value() const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>the error value.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr const error_category &amp; category() const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>the error category.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>error_condition default_error_condition() const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>category().default_error_condition( value() )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>std::string message() const;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>If <code>*this</code> wraps a <code>std::error_code</code> object <code>ec</code>, <code>ec.message()</code>.
Otherwise, <code>category().message( value() )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>char const * message( char * buffer, std::size_t len ) const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>If <code>*this</code> wraps a <code>std::error_code</code> object <code>ec</code>, copies the
string returned from <code>ec.message()</code> into <code>buffer</code> and returns <code>buffer</code>.
Otherwise, returns <code>category().message( value(), buffer, len )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr bool failed() const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>If <code>*this</code> wraps a <code>std::error_code</code> object <code>ec</code>, <code>ec.value() != 0</code>.
Otherwise, <code>category().failed( value() )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr explicit operator bool() const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>failed()</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_comparisons_2">Comparisons</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend constexpr bool operator==( const error_code &amp; lhs,
  const error_code &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>If both <code>lhs</code> and <code>rhs</code> wrap <code>std::error_code</code> objects <code>e1</code> and <code>e2</code>, <code>e1 == e2</code>.
Otherwise, <code>lhs.value() == rhs.value() &amp;&amp; lhs.category() == rhs.category()</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend constexpr bool operator!=( const error_code &amp; lhs,
  const error_code &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>!( lhs == rhs )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend constexpr bool operator&lt;( const error_code &amp; lhs,
  const error_code &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>If both <code>lhs</code> and <code>rhs</code> wrap <code>std::error_code</code> objects <code>e1</code> and <code>e2</code>, <code>e1 &lt; e2</code>.
Otherwise, <code>lhs.category() &lt; rhs.category() || (lhs.category() == rhs.category() &amp;&amp; lhs.value() &lt; rhs.value())</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend bool operator==( const error_code &amp; code,
  const error_condition &amp; condition ) noexcept;</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend bool operator==( const error_condition &amp; condition,
  const error_code &amp; code ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>If <code>code</code> wraps a <code>std::error_code</code> object <code>ec</code>, <code>ec == static_cast&lt;std::error_condition&gt;( condition )</code>.
Otherwise, <code>code.category().equivalent( code.value(), condition ) || condition.category().equivalent( code, condition.value() )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend bool operator!=( const error_code &amp; lhs,
  const error_condition &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend bool operator!=( const error_condition &amp; lhs,
  const error_code &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>!( lhs == rhs )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend bool operator==( const error_code &amp; lhs,
  const std::error_code &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>static_cast&lt;std::error_code&gt;(lhs) == rhs</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend bool operator==( const std::error_code &amp; lhs,
  const error_code &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>lhs == static_cast&lt;std::error_code&gt;(rhs)</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend bool operator!=( const error_code &amp; lhs,
  const std::error_code &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend bool operator!=( const std::error_code &amp; lhs,
  const error_code &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>!( lhs == rhs )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>template&lt;class E&gt;
friend constexpr bool operator==( const error_code &amp; lhs, E rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
</dl>
</div>
<div class="ulist disc">
<ul class="disc">
<li>
<p>When <code>is_error_code_enum&lt;E&gt;::value</code> is <code>true</code>, returns <code>lhs == make_error_code(rhs)</code>;</p>
</li>
<li>
<p>When <code>is_error_condition_enum&lt;E&gt;::value</code> is <code>true</code>, returns <code>lhs == make_error_condition(rhs)</code>;</p>
</li>
<li>
<p>Otherwise, this overload is disabled.</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>template&lt;class E&gt;
friend constexpr bool operator==( E lhs, const error_code &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
</dl>
</div>
<div class="ulist disc">
<ul class="disc">
<li>
<p>When <code>is_error_code_enum&lt;E&gt;::value</code> is <code>true</code>, returns <code>make_error_code(lhs) == rhs</code>;</p>
</li>
<li>
<p>When <code>is_error_condition_enum&lt;E&gt;::value</code> is <code>true</code>, returns <code>make_error_condition(lhs) == rhs</code>;</p>
</li>
<li>
<p>Otherwise, this overload is disabled.</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>template&lt;class E&gt;
friend constexpr bool operator!=( const error_code &amp; lhs, E rhs ) noexcept;</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>template&lt;class E&gt;
friend constexpr bool operator!=( E lhs, const error_code &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>!( lhs == rhs )</code>.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>These overloads are only enabled when
<code>is_error_code_enum&lt;E&gt;::value</code> is <code>true</code> or
<code>is_error_condition_enum&lt;E&gt;::value</code> is <code>true</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_conversions_2">Conversions</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>operator std::error_code() const;</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>operator std::error_code();</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>If <code>*this</code> wraps a <code>std::error_code</code> object <code>ec</code>, <code>ec</code>.
Otherwise, <code>std::error_code( value(), category() )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>template&lt;class T&gt; operator T&amp;();</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>If <code>*this</code> wraps a <code>std::error_code</code> object <code>ec</code>,
returns a reference to <code>ec</code>.
Otherwise, makes <code>*this</code> wrap <code>std::error_code( *this )</code>,
then returns a reference to it.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>This operator is only enabled when <code>T</code> is <code>std::error_code</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_stream_insertion">Stream Insertion</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>template &lt;class charT, class traits&gt;
  std::basic_ostream&lt;charT, traits&gt;&amp;
    operator&lt;&lt;( basic_ostream&lt;charT, traits&gt;&amp; os, const error_code &amp; ec );</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p>If <code>ec</code> wraps a <code>std::error_code</code> object <code>e2</code>, <code>os &lt;&lt; "std:" &lt;&lt; e2</code>.
Otherwise, <code>os &lt;&lt; ec.category().name() &lt;&lt; ':' &lt;&lt; ec.value()</code>.</p>
</dd>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>os</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_nonmembers">Nonmembers</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>std::size_t hash_value( const error_code &amp; ec );</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>If <code>ec</code> wraps a <code>std::error_code</code> object <code>e2</code>, <code>std::hash&lt;std::error_code&gt;()(e2)</code>.
Otherwise, a hash value representing <code>ec</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="ref_boostsystemerror_condition_hpp">&lt;boost/system/&#8203;error_condition.hpp&gt;</h3>
<div class="sect3">
<h4 id="ref_error_condition">error_condition</h4>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>namespace boost {
  namespace system {

    class error_condition {
    public:

      // constructors:

      constexpr error_condition() noexcept;
      constexpr error_condition( int val, const error_category &amp; cat ) noexcept;

      template &lt;class ErrorConditionEnum&gt;
        constexpr error_condition( ErrorConditionEnum e ) noexcept;

      // modifiers:

      constexpr void assign( int val, const error_category &amp; cat ) noexcept;

      template&lt;typename ErrorConditionEnum&gt;
        constexpr error_condition &amp; operator=( ErrorConditionEnum e ) noexcept;

      constexpr void clear() noexcept;

      // observers:

      constexpr int value() const noexcept;
      constexpr const error_category &amp; category() const noexcept;

      std::string message() const;
      char const * message( char * buffer, std::size_t len ) const noexcept;

      constexpr bool failed() const noexcept;
      constexpr explicit operator bool() const noexcept;

      // comparisons:

      friend constexpr bool operator==( const error_condition &amp; lhs,
        const error_condition &amp; rhs ) noexcept;

      friend constexpr bool operator!=( const error_condition &amp; lhs,
        const error_condition &amp; rhs ) noexcept;

      friend constexpr bool operator&lt;( const error_condition &amp; lhs,
        const error_condition &amp; rhs ) noexcept;

      friend bool operator==( const std::error_code &amp; code,
        const error_condition &amp; condition ) noexcept;
      friend bool operator==( const error_condition &amp; condition,
        const std::error_code &amp; code ) noexcept;

      friend bool operator!=( const std::error_code &amp; code,
        const error_condition &amp; condition ) noexcept;
      friend bool operator!=( const error_condition &amp; condition,
        const std::error_code &amp; code ) noexcept;

      // conversions:

      operator std::error_condition() const;

      // stream insertion:

      template &lt;class charT, class traits&gt;
        std::basic_ostream&lt;charT, traits&gt;&amp;
          operator&lt;&lt;( basic_ostream&lt;charT, traits&gt;&amp; os, const error_condition &amp; en );
    };
  }
}</code></pre>
</div>
</div>
<div class="sect4">
<h5 id="ref_constructors_3">Constructors</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr error_condition() noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>value() == 0</code>; <code>category() == generic_category()</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr error_condition( int val, const error_category &amp; cat ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>value() == val</code>; <code>category() == cat</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>template &lt;class ErrorConditionEnum&gt;
  constexpr error_condition( ErrorConditionEnum e ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>*this == make_error_condition( e )</code>.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>This constructor is only enabled when <code>is_error_condition_enum&lt;ErrorConditionEnum&gt;::value</code> is <code>true</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_modifiers_2">Modifiers</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr void assign( int val, const error_category &amp; cat ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>value() == val</code>; <code>category() == cat</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>template &lt;class ErrorConditionEnum&gt;
  constexpr error_condition &amp; operator=( ErrorConditionEnum e ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>*this == make_error_condition( e )</code>.</p>
</dd>
<dt class="hdlist1">Remarks: </dt>
<dd>
<p>This operator is only enabled when <code>is_error_condition_enum&lt;ErrorConditionEnum&gt;::value</code> is <code>true</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr void clear() noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>value() == 0</code>; <code>category() == generic_category()</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_observers_2">Observers</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr int value() const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>the error value.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr const error_category &amp; category() const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>the error category.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>std::string message() const;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>category().message( value() )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>char const * message( char * buffer, std::size_t len ) const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>category().message( value(), buffer, len )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr bool failed() const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>category().failed( value() )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>constexpr explicit operator bool() const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>failed()</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_comparisons_3">Comparisons</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend constexpr bool operator==( const error_condition &amp; lhs,
  const error_condition &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>lhs.value() == rhs.value() &amp;&amp; lhs.category() == rhs.category()</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend constexpr bool operator!=( const error_condition &amp; lhs,
  const error_condition &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>!( lhs == rhs )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend constexpr bool operator&lt;( const error_condition &amp; lhs,
  const error_condition &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>lhs.category() &lt; rhs.category() || (lhs.category() == rhs.category() &amp;&amp; lhs.value() &lt; rhs.value())</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend bool operator==( const std::error_code &amp; code,
  const error_condition &amp; condition ) noexcept;</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend bool operator==( const error_condition &amp; condition,
  const std::error_code &amp; code ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>code == static_cast&lt;std::error_condition&gt;( rhs )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend constexpr bool operator!=( const std::error_code &amp; lhs,
  const error_condition &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>friend constexpr bool operator!=( const error_condition &amp; lhs,
  const std::error_code &amp; rhs ) noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>!( lhs == rhs )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_conversions_3">Conversions</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>operator std::error_condition() const;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>std::error_condition( value(), category() )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_stream_insertion_2">Stream Insertion</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>template &lt;class charT, class traits&gt;
  std::basic_ostream&lt;charT, traits&gt;&amp;
    operator&lt;&lt;( basic_ostream&lt;charT, traits&gt;&amp; os, const error_condition &amp; en );</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Effects: </dt>
<dd>
<p><code>os &lt;&lt; "cond:" &lt;&lt; en.category().name() &lt;&lt; ':' &lt;&lt; en.value()</code>.</p>
</dd>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>os</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="ref_boostsystemsystem_error_hpp">&lt;boost/system/&#8203;system_error.hpp&gt;</h3>
<div class="sect3">
<h4 id="ref_class_system_error">Class system_error</h4>
<div class="paragraph">
<p>The class <code>system_error</code> describes an exception object used to
report errors that have an associated <code>error_code</code>. Such errors
typically originate from operating system or other low-level
application program interfaces.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>namespace boost
{
  namespace system
  {
    class system_error: public std::runtime_error
    {
    public:

      explicit system_error( error_code ec );
      system_error( error_code ec, const char * what_arg );
      system_error( error_code ec, const std::string &amp; what_arg );

      system_error( int ev, const error_category &amp; ecat );
      system_error( int ev, const error_category &amp; ecat,
        const char * what_arg );
      system_error( int ev, const error_category &amp; ecat,
        const std::string &amp; what_arg );

      error_code code() const noexcept;
      const char * what() const noexcept;
    };
  }
}</code></pre>
</div>
</div>
<div class="sect4">
<h5 id="ref_constructors_4">Constructors</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>explicit system_error( error_code ec );
system_error( error_code ec, const char * what_arg );
system_error( error_code ec, const std::string &amp; what_arg );</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>code() == ec</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>system_error( int ev, const error_category &amp; ecat,
  const char * what_arg );
system_error( int ev, const error_category &amp; ecat,
  const std::string &amp; what_arg );
system_error( int ev, const error_category &amp; ecat );</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Ensures: </dt>
<dd>
<p><code>code() == error_code( ev, ecat )</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
<div class="sect4">
<h5 id="ref_observers_3">Observers</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>error_code code() const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p><code>ec</code> or <code>error_code( ev, ecat )</code>, from the constructor, as appropriate.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>const char * what() const noexcept;</code></pre>
</div>
</div>
<div class="ulist none">
<ul class="none">
<li>
<p></p>
<div class="dlist">
<dl>
<dt class="hdlist1">Returns: </dt>
<dd>
<p>A null-terminated character string incorporating the arguments supplied
in the constructor, typically of the form <code>what_arg + ": " + code().message()</code>.</p>
</dd>
</dl>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="ref_boostsystem_hpp">&lt;boost/system.hpp&gt;</h3>
<div class="paragraph">
<p>This convenience header includes all the headers previously described.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="history">History</h2>
<div class="sectionbody">
<div class="paragraph">
<p><a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n1975.html">N1975</a>,
Filesystem Library Proposal for TR2, accepted for Library Technical
Report 2 (TR2) at the Berlin meeting, included additional components to
supplement the Standard Library&#8217;s Diagnostics clause. Since then, these error
reporting components have received wider public scrutiny and enhancements have
been made to the design. The enhanced version has been used by
<a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2054.pdf">N2054</a>,
Networking  Library Proposal for TR2, demonstrating that these error reporting
components are useful beyond the original Filesystem Library.</p>
</div>
<div class="paragraph">
<p>The original proposal viewed error categories as a binary choice between
<code>errno</code> (i.e. POSIX-style) and the native operating system&#8217;s error
codes. The proposed components now allow as many additional error categories as
are needed by either implementations or by users. The need to support additional
error categories, for example, occurs in some networking library implementations
because they are built on top of the POSIX <code>getaddrinfo</code> API that
uses error codes not based on <code>errno</code>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="acknowledgments">Acknowledgments</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Christopher Kohlhoff and Peter Dimov made important contributions to the
design. Comments and suggestions were also received from Pavel Vozenilek,
Gennaro Prota, Dave Abrahams, Jeff Garland, Iain Hanson, Oliver Kowalke, and
Oleg Abrosimov. Christopher Kohlhoff suggested several improvements to the
<a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2066.html">N2066</a>
paper. Johan Nilsson&#8217;s comments led to several of the refinements in N2066.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="copyright">Copyright and License</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This documentation is</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Copyright 2003-2017 Beman Dawes</p>
</li>
<li>
<p>Copyright 2018-2021 Peter Dimov</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>and is distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2021-08-05 09:42:49 UTC
</div>
</div>
<style>

*:not(pre)>code { background: none; color: #600000; }
:not(pre):not([class^=L])>code { background: none; color: #600000; }

</style>
</body>
</html>